<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Class template basic_command_line_parser</title>
<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../program_options/reference.html#doxygen.parsers_8hpp" title="Header &lt;boost/program_options/parsers.hpp&gt;">
<link rel="prev" href="classboost_1_1program__options_1_1options__description__easy__init.html" title="Class options_description_easy_init">
<link rel="next" href="classboost_1_1program__options_1_1basic__parsed__options_3_01wchar__t_01_4.html" title="Class basic_parsed_options&lt;wchar_t&gt;">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.html">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="classboost_1_1program__options_1_1options__description__easy__init.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../program_options/reference.html#doxygen.parsers_8hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="classboost_1_1program__options_1_1basic__parsed__options_3_01wchar__t_01_4.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="doxygen.classboost_1_1program__options_1_1basic__command__line__parser"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template basic_command_line_parser</span></h2>
<p>boost::program_options::basic_command_line_parser</p>
</div>
<h2 class="refsynopsisdiv-title">Synopsis</h2>
<div class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../program_options/reference.html#doxygen.parsers_8hpp" title="Header &lt;boost/program_options/parsers.hpp&gt;">boost/program_options/parsers.hpp</a>&gt;

</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> charT<span class="special">&gt;</span> 
<span class="keyword">class</span> <a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>

  <span class="comment">// <a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html#id-1_3_29_9_8_1_1_1_3-bb">public member functions</a></span>
  <a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html#doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1ab9cf97e8f7443bef47ec7e39748c6716"><span class="identifier">basic_command_line_parser</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special">&lt;</span> <span class="identifier">charT</span> <span class="special">&gt;</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html#doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1a44299860b8a47cee68e658daafcbe15a"><span class="identifier">basic_command_line_parser</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&amp;</span> <a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html#doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1a7b5b674c9b6c884fd6d86aa74853fc8f"><span class="identifier">options</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1program__options_1_1options__description.html" title="Class options_description">options_description</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&amp;</span> 
  <a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html#doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1a9355b944f2959b3340bf00f488d78404"><span class="identifier">positional</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1program__options_1_1positional__options__description.html" title="Class positional_options_description">positional_options_description</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&amp;</span> <a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html#doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1a1755ce06851874809f94174f3405f6f2"><span class="identifier">style</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&amp;</span> <a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html#doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1a2d73cfd782b9374e1acd080753514a9b"><span class="identifier">extra_parser</span></a><span class="special">(</span><span class="identifier">ext_parser</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="classboost_1_1program__options_1_1basic__parsed__options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special">&lt;</span> <span class="identifier">charT</span> <span class="special">&gt;</span> <a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html#doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1a63c7062f583f40f7cd8fcdf9f8b0161f"><span class="identifier">run</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&amp;</span> <a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html#doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1a6d0d5d8918ab0ac64f2941be1857036f"><span class="identifier">allow_unregistered</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&amp;</span> <a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html#doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1a50fd63a3c8a3e9061dabb7ccb89c0e29"><span class="identifier">extra_style_parser</span></a><span class="special">(</span><span class="identifier">style_parser</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id-1.3.29.9.9.3.4"></a><h2>Description</h2>
<p>Command line parser.</p>
<p>The class allows one to specify all the information needed for parsing and to parse the command line. It is primarily needed to emulate named function parameters -- a regular function with 5 parameters will be hard to use and creating overloads with a smaller number of parameters will be confusing.</p>
<p>For the most common case, the function parse_command_line is a better alternative.</p>
<p>There are two typedefs -- command_line_parser and wcommand_line_parser, for charT == char and charT == wchar_t cases. </p>
<div class="refsect2">
<a name="id-1.3.29.9.9.3.4.6"></a><h3>
<a name="id-1_3_29_9_8_1_1_1_3-bb"></a><code class="computeroutput">basic_command_line_parser</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1ab9cf97e8f7443bef47ec7e39748c6716"></a><span class="identifier">basic_command_line_parser</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special">&lt;</span> <span class="identifier">charT</span> <span class="special">&gt;</span> <span class="special">&gt;</span> <span class="special">&amp;</span> args<span class="special">)</span><span class="special">;</span></pre>
<p>Creates a command line parser for the specified arguments list. The 'args' parameter should not include program name. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1a44299860b8a47cee68e658daafcbe15a"></a><span class="identifier">basic_command_line_parser</span><span class="special">(</span><span class="keyword">int</span> argc<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> argv<span class="special">)</span><span class="special">;</span></pre>
<p>Creates a command line parser for the specified arguments list. The parameters should be the same as passed to 'main', meaning: 
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">argc</code></span></p></td>
<td><p>Must be non-negative i.e. &gt;= 0 </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">argv</code></span></p></td>
<td><p>Argv[argc] must be 0 e.g. nullptr and if argc is &gt;0 argv[0] up to argv[argc-1] must point to null terminated strings </p></td>
</tr>
</tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&amp;</span> <a name="doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1a7b5b674c9b6c884fd6d86aa74853fc8f"></a><span class="identifier">options</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1program__options_1_1options__description.html" title="Class options_description">options_description</a> <span class="special">&amp;</span> desc<span class="special">)</span><span class="special">;</span></pre>
<p>Sets options descriptions to use. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&amp;</span> 
<a name="doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1a9355b944f2959b3340bf00f488d78404"></a><span class="identifier">positional</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1program__options_1_1positional__options__description.html" title="Class positional_options_description">positional_options_description</a> <span class="special">&amp;</span> desc<span class="special">)</span><span class="special">;</span></pre>
<p>Sets positional options description to use. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&amp;</span> <a name="doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1a1755ce06851874809f94174f3405f6f2"></a><span class="identifier">style</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span></pre>
<p>Sets the command line style. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&amp;</span> <a name="doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1a2d73cfd782b9374e1acd080753514a9b"></a><span class="identifier">extra_parser</span><span class="special">(</span><span class="identifier">ext_parser</span><span class="special">)</span><span class="special">;</span></pre>
<p>Sets the extra parsers. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="classboost_1_1program__options_1_1basic__parsed__options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special">&lt;</span> <span class="identifier">charT</span> <span class="special">&gt;</span> <a name="doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1a63c7062f583f40f7cd8fcdf9f8b0161f"></a><span class="identifier">run</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Parses the options and returns the result of parsing. Throws on error. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&amp;</span> <a name="doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1a6d0d5d8918ab0ac64f2941be1857036f"></a><span class="identifier">allow_unregistered</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Specifies that unregistered options are allowed and should be passed though. For each command like token that looks like an option but does not contain a recognized name, an instance of basic_option&lt;charT&gt; will be added to result, with 'unrecognized' field set to 'true'. It's possible to collect all unrecognized options with the 'collect_unrecognized' funciton. </p>
</li>
<li class="listitem"><pre class="literallayout"><a class="link" href="classboost_1_1program__options_1_1basic__command__line__parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&amp;</span> <a name="doxygen.classboost_1_1program__options_1_1basic__command__line__parser_1a50fd63a3c8a3e9061dabb7ccb89c0e29"></a><span class="identifier">extra_style_parser</span><span class="special">(</span><span class="identifier">style_parser</span> s<span class="special">)</span><span class="special">;</span></pre></li>
</ol></div>
</div>
</div>
</div>
<div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0.
      (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at 
      <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="classboost_1_1program__options_1_1options__description__easy__init.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../program_options/reference.html#doxygen.parsers_8hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="classboost_1_1program__options_1_1basic__parsed__options_3_01wchar__t_01_4.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
